<!DOCTYPE HTML>

<html lang="en">
<head>

<title>SwitchUserWebFilter (spring-security-docs 5.6.3 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="SwitchUserWebFilter (spring-security-docs 5.6.3 API)";
        }
    }
    catch(err) {
    }
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">

<div class="topNav"><a id="navbar.top">

</a>
<div class="skipNav"><a href="SwitchUserWebFilter.html#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="SwitchUserWebFilter.html#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="SwitchUserWebFilter.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="SwitchUserWebFilter.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="SwitchUserWebFilter.html#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="SwitchUserWebFilter.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="SwitchUserWebFilter.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">

</a></div>

</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>

<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.springframework.security.web.server.authentication</a></div>
<h2 title="Class SwitchUserWebFilter" class="title">Class SwitchUserWebFilter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.springframework.security.web.server.authentication.SwitchUserWebFilter</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>org.springframework.web.server.WebFilter</code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">SwitchUserWebFilter</span>
extends java.lang.Object
implements org.springframework.web.server.WebFilter</pre>
<div class="block">Switch User processing filter responsible for user context switching. A common use-case
for this feature is the ability to allow higher-authority users (e.g. ROLE_ADMIN) to
switch to a regular user (e.g. ROLE_USER).
<p>
This filter assumes that the user performing the switch will be required to be logged
in as normal user (i.e. with a ROLE_ADMIN role). The user will then access a
page/controller that enables the administrator to specify who they wish to become (see
<code>switchUserUrl</code>).
<p>
<b>Note: This URL will be required to have appropriate security constraints configured
so that only users of that role can access it (e.g. ROLE_ADMIN).</b>
<p>
On a successful switch, the user's <code>SecurityContext</code> will be updated to
reflect the specified user and will also contain an additional
<a href="../../authentication/switchuser/SwitchUserGrantedAuthority.html" title="class in org.springframework.security.web.authentication.switchuser"><code>SwitchUserGrantedAuthority</code></a>
which contains the original user. Before switching, a check will be made on whether the
user is already currently switched, and any current switch will be exited to prevent
"nested" switches.
<p>
To 'exit' from a user context, the user needs to access a URL (see
<code>exitUserUrl</code>) that will switch back to the original user as identified by
the <code>ROLE_PREVIOUS_ADMINISTRATOR</code>.
<p>
To configure the Switch User Processing Filter, create a bean definition for the Switch
User processing filter and add to the filterChainProxy. Note that the filter must come
<b>after</b> the
<a href="../../../config/web/server/SecurityWebFiltersOrder.html#AUTHORIZATION"><code>SecurityWebFiltersOrder.AUTHORIZATION</code></a>
in the chain, in order to apply the correct constraints to the <tt>switchUserUrl</tt>.
Example: <pre> SwitchUserWebFilter filter = new SwitchUserWebFilter(userDetailsService, loginSuccessHandler, failureHandler);
 http.addFilterAfter(filter, SecurityWebFiltersOrder.AUTHORIZATION);
 </pre></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.4</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../authentication/switchuser/SwitchUserGrantedAuthority.html" title="class in org.springframework.security.web.authentication.switchuser"><code>SwitchUserGrantedAuthority</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">

</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SwitchUserWebFilter.html#ROLE_PREVIOUS_ADMINISTRATOR">ROLE_PREVIOUS_ADMINISTRATOR</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SwitchUserWebFilter.html#SPRING_SECURITY_SWITCH_USERNAME_KEY">SPRING_SECURITY_SWITCH_USERNAME_KEY</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">

</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="SwitchUserWebFilter.html#%3Cinit%3E(org.springframework.security.core.userdetails.ReactiveUserDetailsService,java.lang.String,java.lang.String)">SwitchUserWebFilter</a></span>&#8203;(<a href="../../../core/userdetails/ReactiveUserDetailsService.html" title="interface in org.springframework.security.core.userdetails">ReactiveUserDetailsService</a>&nbsp;userDetailsService,
java.lang.String&nbsp;successTargetUrl,
java.lang.String&nbsp;failureTargetUrl)</code></th>
<td class="colLast">
<div class="block">Creates a filter for the user context switching</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="SwitchUserWebFilter.html#%3Cinit%3E(org.springframework.security.core.userdetails.ReactiveUserDetailsService,org.springframework.security.web.server.authentication.ServerAuthenticationSuccessHandler,org.springframework.security.web.server.authentication.ServerAuthenticationFailureHandler)">SwitchUserWebFilter</a></span>&#8203;(<a href="../../../core/userdetails/ReactiveUserDetailsService.html" title="interface in org.springframework.security.core.userdetails">ReactiveUserDetailsService</a>&nbsp;userDetailsService,
<a href="ServerAuthenticationSuccessHandler.html" title="interface in org.springframework.security.web.server.authentication">ServerAuthenticationSuccessHandler</a>&nbsp;successHandler,
<a href="ServerAuthenticationFailureHandler.html" title="interface in org.springframework.security.web.server.authentication">ServerAuthenticationFailureHandler</a>&nbsp;failureHandler)</code></th>
<td class="colLast">
<div class="block">Creates a filter for the user context switching</div>
</td>
</tr>
</table>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">

</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected reactor.core.publisher.Mono&lt;<a href="../../../core/Authentication.html" title="interface in org.springframework.security.core">Authentication</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SwitchUserWebFilter.html#exitSwitchUser(org.springframework.security.web.server.WebFilterExchange)">exitSwitchUser</a></span>&#8203;(<a href="../WebFilterExchange.html" title="class in org.springframework.security.web.server">WebFilterExchange</a>&nbsp;webFilterExchange)</code></th>
<td class="colLast">
<div class="block">Attempt to exit from an already switched user.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>reactor.core.publisher.Mono&lt;java.lang.Void&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SwitchUserWebFilter.html#filter(org.springframework.web.server.ServerWebExchange,org.springframework.web.server.WebFilterChain)">filter</a></span>&#8203;(org.springframework.web.server.ServerWebExchange&nbsp;exchange,
org.springframework.web.server.WebFilterChain&nbsp;chain)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SwitchUserWebFilter.html#getUsername(org.springframework.web.server.ServerWebExchange)">getUsername</a></span>&#8203;(org.springframework.web.server.ServerWebExchange&nbsp;exchange)</code></th>
<td class="colLast">
<div class="block">Returns the name of the target user.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SwitchUserWebFilter.html#setExitUserMatcher(org.springframework.security.web.server.util.matcher.ServerWebExchangeMatcher)">setExitUserMatcher</a></span>&#8203;(<a href="../util/matcher/ServerWebExchangeMatcher.html" title="interface in org.springframework.security.web.server.util.matcher">ServerWebExchangeMatcher</a>&nbsp;exitUserMatcher)</code></th>
<td class="colLast">
<div class="block">Set the matcher to respond to exit user processing.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SwitchUserWebFilter.html#setExitUserUrl(java.lang.String)">setExitUserUrl</a></span>&#8203;(java.lang.String&nbsp;exitUserUrl)</code></th>
<td class="colLast">
<div class="block">Set the URL to respond to exit user processing.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SwitchUserWebFilter.html#setSecurityContextRepository(org.springframework.security.web.server.context.ServerSecurityContextRepository)">setSecurityContextRepository</a></span>&#8203;(<a href="../context/ServerSecurityContextRepository.html" title="interface in org.springframework.security.web.server.context">ServerSecurityContextRepository</a>&nbsp;securityContextRepository)</code></th>
<td class="colLast">
<div class="block">Sets the repository for persisting the SecurityContext.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SwitchUserWebFilter.html#setSwitchUserMatcher(org.springframework.security.web.server.util.matcher.ServerWebExchangeMatcher)">setSwitchUserMatcher</a></span>&#8203;(<a href="../util/matcher/ServerWebExchangeMatcher.html" title="interface in org.springframework.security.web.server.util.matcher">ServerWebExchangeMatcher</a>&nbsp;switchUserMatcher)</code></th>
<td class="colLast">
<div class="block">Set the matcher to respond to switch user processing.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SwitchUserWebFilter.html#setSwitchUserUrl(java.lang.String)">setSwitchUserUrl</a></span>&#8203;(java.lang.String&nbsp;switchUserUrl)</code></th>
<td class="colLast">
<div class="block">Set the URL to respond to switch user processing.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>protected reactor.core.publisher.Mono&lt;<a href="../../../core/Authentication.html" title="interface in org.springframework.security.core">Authentication</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SwitchUserWebFilter.html#switchUser(org.springframework.security.web.server.WebFilterExchange)">switchUser</a></span>&#8203;(<a href="../WebFilterExchange.html" title="class in org.springframework.security.web.server">WebFilterExchange</a>&nbsp;webFilterExchange)</code></th>
<td class="colLast">
<div class="block">Attempt to switch to another user.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">

</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">

</a>
<h3>Field Detail</h3>
<a id="SPRING_SECURITY_SWITCH_USERNAME_KEY">

</a>
<ul class="blockList">
<li class="blockList">
<h4>SPRING_SECURITY_SWITCH_USERNAME_KEY</h4>
<pre>public static final&nbsp;java.lang.String SPRING_SECURITY_SWITCH_USERNAME_KEY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.springframework.security.web.server.authentication.SwitchUserWebFilter.SPRING_SECURITY_SWITCH_USERNAME_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="ROLE_PREVIOUS_ADMINISTRATOR">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ROLE_PREVIOUS_ADMINISTRATOR</h4>
<pre>public static final&nbsp;java.lang.String ROLE_PREVIOUS_ADMINISTRATOR</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.springframework.security.web.server.authentication.SwitchUserWebFilter.ROLE_PREVIOUS_ADMINISTRATOR">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">

</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.springframework.security.core.userdetails.ReactiveUserDetailsService,org.springframework.security.web.server.authentication.ServerAuthenticationSuccessHandler,org.springframework.security.web.server.authentication.ServerAuthenticationFailureHandler)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>SwitchUserWebFilter</h4>
<pre>public&nbsp;SwitchUserWebFilter&#8203;(<a href="../../../core/userdetails/ReactiveUserDetailsService.html" title="interface in org.springframework.security.core.userdetails">ReactiveUserDetailsService</a>&nbsp;userDetailsService,
                           <a href="ServerAuthenticationSuccessHandler.html" title="interface in org.springframework.security.web.server.authentication">ServerAuthenticationSuccessHandler</a>&nbsp;successHandler,
                           @Nullable
                           <a href="ServerAuthenticationFailureHandler.html" title="interface in org.springframework.security.web.server.authentication">ServerAuthenticationFailureHandler</a>&nbsp;failureHandler)</pre>
<div class="block">Creates a filter for the user context switching</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>userDetailsService</code> - The <tt>UserDetailsService</tt> which will be used to
load information for the user that is being switched to.</dd>
<dd><code>successHandler</code> - Used to define custom behaviour on a successful switch or
exit user.</dd>
<dd><code>failureHandler</code> - Used to define custom behaviour when a switch fails.</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(org.springframework.security.core.userdetails.ReactiveUserDetailsService,java.lang.String,java.lang.String)">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SwitchUserWebFilter</h4>
<pre>public&nbsp;SwitchUserWebFilter&#8203;(<a href="../../../core/userdetails/ReactiveUserDetailsService.html" title="interface in org.springframework.security.core.userdetails">ReactiveUserDetailsService</a>&nbsp;userDetailsService,
                           java.lang.String&nbsp;successTargetUrl,
                           @Nullable
                           java.lang.String&nbsp;failureTargetUrl)</pre>
<div class="block">Creates a filter for the user context switching</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>userDetailsService</code> - The <tt>UserDetailsService</tt> which will be used to
load information for the user that is being switched to.</dd>
<dd><code>successTargetUrl</code> - Sets the URL to go to after a successful switch / exit user
request</dd>
<dd><code>failureTargetUrl</code> - The URL to which a user should be redirected if the switch
fails</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">

</a>
<h3>Method Detail</h3>
<a id="filter(org.springframework.web.server.ServerWebExchange,org.springframework.web.server.WebFilterChain)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>filter</h4>
<pre class="methodSignature">public&nbsp;reactor.core.publisher.Mono&lt;java.lang.Void&gt;&nbsp;filter&#8203;(org.springframework.web.server.ServerWebExchange&nbsp;exchange,
                                                          org.springframework.web.server.WebFilterChain&nbsp;chain)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>filter</code>&nbsp;in interface&nbsp;<code>org.springframework.web.server.WebFilter</code></dd>
</dl>
</li>
</ul>
<a id="switchUser(org.springframework.security.web.server.WebFilterExchange)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>switchUser</h4>
<pre class="methodSignature">protected&nbsp;reactor.core.publisher.Mono&lt;<a href="../../../core/Authentication.html" title="interface in org.springframework.security.core">Authentication</a>&gt;&nbsp;switchUser&#8203;(<a href="../WebFilterExchange.html" title="class in org.springframework.security.web.server">WebFilterExchange</a>&nbsp;webFilterExchange)</pre>
<div class="block">Attempt to switch to another user.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>webFilterExchange</code> - The web filter exchange</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The new <code>Authentication</code> object if successfully switched to
another user, <code>Mono.empty()</code> otherwise.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../authentication/AuthenticationCredentialsNotFoundException.html" title="class in org.springframework.security.authentication">AuthenticationCredentialsNotFoundException</a></code> - If the target user can not be
found by username</dd>
</dl>
</li>
</ul>
<a id="exitSwitchUser(org.springframework.security.web.server.WebFilterExchange)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>exitSwitchUser</h4>
<pre class="methodSignature">protected&nbsp;reactor.core.publisher.Mono&lt;<a href="../../../core/Authentication.html" title="interface in org.springframework.security.core">Authentication</a>&gt;&nbsp;exitSwitchUser&#8203;(<a href="../WebFilterExchange.html" title="class in org.springframework.security.web.server">WebFilterExchange</a>&nbsp;webFilterExchange)</pre>
<div class="block">Attempt to exit from an already switched user.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>webFilterExchange</code> - The web filter exchange</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The original <code>Authentication</code> object.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../authentication/AuthenticationCredentialsNotFoundException.html" title="class in org.springframework.security.authentication">AuthenticationCredentialsNotFoundException</a></code> - If there is no
<code>Authentication</code> associated with this request or the user is not
switched.</dd>
</dl>
</li>
</ul>
<a id="getUsername(org.springframework.web.server.ServerWebExchange)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>getUsername</h4>
<pre class="methodSignature">protected&nbsp;java.lang.String&nbsp;getUsername&#8203;(org.springframework.web.server.ServerWebExchange&nbsp;exchange)</pre>
<div class="block">Returns the name of the target user.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>exchange</code> - The server web exchange</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the target user.</dd>
</dl>
</li>
</ul>
<a id="setSecurityContextRepository(org.springframework.security.web.server.context.ServerSecurityContextRepository)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>setSecurityContextRepository</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setSecurityContextRepository&#8203;(<a href="../context/ServerSecurityContextRepository.html" title="interface in org.springframework.security.web.server.context">ServerSecurityContextRepository</a>&nbsp;securityContextRepository)</pre>
<div class="block">Sets the repository for persisting the SecurityContext. Default is
<a href="../context/WebSessionServerSecurityContextRepository.html" title="class in org.springframework.security.web.server.context"><code>WebSessionServerSecurityContextRepository</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>securityContextRepository</code> - the repository to use</dd>
</dl>
</li>
</ul>
<a id="setExitUserUrl(java.lang.String)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>setExitUserUrl</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setExitUserUrl&#8203;(java.lang.String&nbsp;exitUserUrl)</pre>
<div class="block">Set the URL to respond to exit user processing. This is a shortcut for *
<a href="SwitchUserWebFilter.html#setExitUserMatcher(org.springframework.security.web.server.util.matcher.ServerWebExchangeMatcher)"><code>setExitUserMatcher(ServerWebExchangeMatcher)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>exitUserUrl</code> - The exit user URL.</dd>
</dl>
</li>
</ul>
<a id="setExitUserMatcher(org.springframework.security.web.server.util.matcher.ServerWebExchangeMatcher)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>setExitUserMatcher</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setExitUserMatcher&#8203;(<a href="../util/matcher/ServerWebExchangeMatcher.html" title="interface in org.springframework.security.web.server.util.matcher">ServerWebExchangeMatcher</a>&nbsp;exitUserMatcher)</pre>
<div class="block">Set the matcher to respond to exit user processing.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>exitUserMatcher</code> - The exit matcher to use</dd>
</dl>
</li>
</ul>
<a id="setSwitchUserUrl(java.lang.String)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>setSwitchUserUrl</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setSwitchUserUrl&#8203;(java.lang.String&nbsp;switchUserUrl)</pre>
<div class="block">Set the URL to respond to switch user processing. This is a shortcut for
<a href="SwitchUserWebFilter.html#setSwitchUserMatcher(org.springframework.security.web.server.util.matcher.ServerWebExchangeMatcher)"><code>setSwitchUserMatcher(ServerWebExchangeMatcher)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>switchUserUrl</code> - The switch user URL.</dd>
</dl>
</li>
</ul>
<a id="setSwitchUserMatcher(org.springframework.security.web.server.util.matcher.ServerWebExchangeMatcher)">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setSwitchUserMatcher</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setSwitchUserMatcher&#8203;(<a href="../util/matcher/ServerWebExchangeMatcher.html" title="interface in org.springframework.security.web.server.util.matcher">ServerWebExchangeMatcher</a>&nbsp;switchUserMatcher)</pre>
<div class="block">Set the matcher to respond to switch user processing.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>switchUserMatcher</code> - The switch user matcher.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>

<footer role="contentinfo">
<nav role="navigation">

<div class="bottomNav"><a id="navbar.bottom">

</a>
<div class="skipNav"><a href="SwitchUserWebFilter.html#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="SwitchUserWebFilter.html#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="SwitchUserWebFilter.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="SwitchUserWebFilter.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="SwitchUserWebFilter.html#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="SwitchUserWebFilter.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="SwitchUserWebFilter.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">

</a></div>

</nav>
</footer>
<script>if (window.parent == window) {(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');ga('create', 'UA-2728886-23', 'auto', {'siteSpeedSampleRate': 100});ga('send', 'pageview');}</script><script defer src="https://static.cloudflareinsights.com/beacon.min.js/v652eace1692a40cfa3763df669d7439c1639079717194" integrity="sha512-Gi7xpJR8tSkrpF7aordPZQlW2DLtzUlZcumS8dMQjwDHEnw9I7ZLyiOj/6tZStRBGtGgN6ceN6cMH8z7etPGlw==" data-cf-beacon='{"rayId":"7040f1b1ba3b97cf","token":"bffcb8a918ae4755926f76178bfbd26b","version":"2021.12.0","si":100}' crossorigin="anonymous"></script>
</body>
</html>
